Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Config file: make sphinx or mkdocs configuration required for projects using Sphinx or MkDocs #11852

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

stsewd
Copy link
Member

@stsewd stsewd commented Dec 13, 2024

  • This introduces a breaking change for users overriding the new (undocumented) jobs (create_environment, install, build.html and friends). This is, if they have overridden any of those jobs without explicitly declaring a Sphinx or MkDocs key, we will no longer run the sphinx/mkdocs commands, not their setup.
  • This hardcodes the dates from Post: deprecate config files without sphinx or mkdocs configuration website#342 to through an error to users using the configuration file without an explicit sphinx/mkdocs configuration.

This allows for users to keep using the new overrides without worrying about sphinx/mkdocs, while giving enough time to old users to migrate their projects to give an explicit path.

Some notes

  • We are allowing to use sphinx/mkdocs and probably other keys with build.commands, even if those keys don't affect the build in anything. Not really something that "interrupt" users in any way, but it can be missleading.
  • A next step should be to not make python required at all, right now we still create a virtual environment. We probably want to create a virtual env only if python was provided in the list of build.tools.

Ref:

Copy link

sentry-io bot commented Dec 13, 2024

🔍 Existing Issues For Review

Your pull request is modifying functions with the following pre-existing issues:

📄 File: readthedocs/config/config.py

Function Unhandled Issue
validate TypeError: sequence item 0: expected str instance, bool found readthedocs.projects.tasks.builds.upd...
Event Count: 6

Did you find this useful? React with a 👍 or 👎

@stsewd stsewd marked this pull request as ready for review December 13, 2024 03:24
@stsewd stsewd requested review from a team as code owners December 13, 2024 03:24
@stsewd stsewd requested a review from ericholscher December 13, 2024 03:24
Copy link
Member

@ericholscher ericholscher left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks great to me. It seems like we're unblocking ourselves for supporting build.jobs.build for other projects while doing the deprecation here?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants